<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    <title>Wi-Fi Host Driver (WHD): WHD Wi-Fi Join, Scan and Halt API</title>
    <link href="tabs.css" rel="stylesheet" type="text/css"/>
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
    <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
      <div id="titlearea" style="font-family:verdana;">
        <table border='0' cellpadding='0' cellspacing='0' width="98%">
          <tr style="height:20px"><td>&nbsp;</td></tr>
          <tr style="border-collapse: collapse; padding: 0;">
            <td style="width:20px"></td>
            <td style="width:117px"><img src="ifx_logo.png" alt="Infineon Logo" /></td>
            <td style="vertical-align:middle; text-align:center; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
              Wi-Fi Host Driver (WHD) Public API Reference Guide
            </td>
          </tr>
          <tr><td>&nbsp;</td></tr>
        </table>
    </div>
    <!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__wifijoin.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">WHD Wi-Fi Join, Scan and Halt API<div class="ingroups"><a class="el" href="group__wifi.html">WHD Wi-Fi API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Wi-Fi APIs for join, scan &amp; leave. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga9f8c6096922212981dd2101a17aec471"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga9f8c6096922212981dd2101a17aec471">whd_scan_result_callback_t</a>) (<a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> **result_ptr, void *user_data, <a class="el" href="whd__types_8h.html#a34d5a5749a0bcc00b7249108a8670ada">whd_scan_status_t</a> status)</td></tr>
<tr class="memdesc:ga9f8c6096922212981dd2101a17aec471"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan result callback function pointer type.  <a href="#ga9f8c6096922212981dd2101a17aec471">More...</a><br /></td></tr>
<tr class="separator:ga9f8c6096922212981dd2101a17aec471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2604c8dec9eff39e79b3281496da2611"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga2604c8dec9eff39e79b3281496da2611">whd_auth_result_callback_t</a>) (void *result_ptr, uint32_t len, <a class="el" href="whd__types_8h.html#a853c6ba0cbd32dd7ec37dac9f8ccbfa7">whd_auth_status_t</a> status, uint8_t *flag, void *user_data)</td></tr>
<tr class="memdesc:ga2604c8dec9eff39e79b3281496da2611"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auth result callback function pointer type.  <a href="#ga2604c8dec9eff39e79b3281496da2611">More...</a><br /></td></tr>
<tr class="separator:ga2604c8dec9eff39e79b3281496da2611"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad89b3244a31c2ed9122d266b7f99def0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#gad89b3244a31c2ed9122d266b7f99def0">whd_wifi_scan_synch</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="whd__types_8h.html#ab30a697b3ebbf2007dc09194b54b1a1b">whd_sync_scan_result_t</a> *scan_result, uint32_t *count)</td></tr>
<tr class="memdesc:gad89b3244a31c2ed9122d266b7f99def0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates a scan to search for 802.11 networks.  <a href="#gad89b3244a31c2ed9122d266b7f99def0">More...</a><br /></td></tr>
<tr class="separator:gad89b3244a31c2ed9122d266b7f99def0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga253707d44ba49bb46256b38c1c1a204e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga253707d44ba49bb46256b38c1c1a204e">whd_wifi_scan</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="whd__types_8h.html#af7ac1b0be4ce67f3e82b876c2f27fd3a">whd_scan_type_t</a> scan_type, <a class="el" href="whd__types_8h.html#a3070614a06a8989b9eb207e9f1286c5f">whd_bss_type_t</a> bss_type, const <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *optional_ssid, const <a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *optional_mac, const uint16_t *optional_channel_list, const <a class="el" href="structwhd__scan__extended__params__t.html">whd_scan_extended_params_t</a> *optional_extended_params, <a class="el" href="group__wifijoin.html#ga9f8c6096922212981dd2101a17aec471">whd_scan_result_callback_t</a> callback, <a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> *result_ptr, void *user_data)</td></tr>
<tr class="memdesc:ga253707d44ba49bb46256b38c1c1a204e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates a scan to search for 802.11 networks.  <a href="#ga253707d44ba49bb46256b38c1c1a204e">More...</a><br /></td></tr>
<tr class="separator:ga253707d44ba49bb46256b38c1c1a204e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b67138e3689fb66ce526810ed188f4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga1b67138e3689fb66ce526810ed188f4d">whd_wifi_stop_scan</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:ga1b67138e3689fb66ce526810ed188f4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort a previously issued scan.  <a href="#ga1b67138e3689fb66ce526810ed188f4d">More...</a><br /></td></tr>
<tr class="separator:ga1b67138e3689fb66ce526810ed188f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a393cc47dd501a2bf00d4a0d305dd6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga7a393cc47dd501a2bf00d4a0d305dd6e">whd_wifi_external_auth_request</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="group__wifijoin.html#ga2604c8dec9eff39e79b3281496da2611">whd_auth_result_callback_t</a> callback, void *result_ptr, void *user_data)</td></tr>
<tr class="memdesc:ga7a393cc47dd501a2bf00d4a0d305dd6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates SAE auth.  <a href="#ga7a393cc47dd501a2bf00d4a0d305dd6e">More...</a><br /></td></tr>
<tr class="separator:ga7a393cc47dd501a2bf00d4a0d305dd6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf24ce3dea8e8e0d61f5ee82e2429b1b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#gaf24ce3dea8e8e0d61f5ee82e2429b1b4">whd_wifi_stop_external_auth_request</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:gaf24ce3dea8e8e0d61f5ee82e2429b1b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort authentication request.  <a href="#gaf24ce3dea8e8e0d61f5ee82e2429b1b4">More...</a><br /></td></tr>
<tr class="separator:gaf24ce3dea8e8e0d61f5ee82e2429b1b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafde10c6bc61306ec3292a0aede919baf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#gafde10c6bc61306ec3292a0aede919baf">whd_wifi_join</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, const <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *ssid, <a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> auth_type, const uint8_t *security_key, uint8_t key_length)</td></tr>
<tr class="memdesc:gafde10c6bc61306ec3292a0aede919baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Joins a Wi-Fi network.  <a href="#gafde10c6bc61306ec3292a0aede919baf">More...</a><br /></td></tr>
<tr class="separator:gafde10c6bc61306ec3292a0aede919baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga149e2de0e902c6f7de181c65f93dff3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#ga149e2de0e902c6f7de181c65f93dff3c">whd_wifi_join_specific</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, const <a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> *ap, const uint8_t *security_key, uint8_t key_length)</td></tr>
<tr class="memdesc:ga149e2de0e902c6f7de181c65f93dff3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Joins a specific Wi-Fi network.  <a href="#ga149e2de0e902c6f7de181c65f93dff3c">More...</a><br /></td></tr>
<tr class="separator:ga149e2de0e902c6f7de181c65f93dff3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab76c5c1b2c85ba90657b0fe249fc8ebd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#gab76c5c1b2c85ba90657b0fe249fc8ebd">whd_wifi_set_chanspec</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="whd__types_8h.html#ac2f5aa33ad4da263645133854e489c76">wl_chanspec_t</a> chanspec)</td></tr>
<tr class="memdesc:gab76c5c1b2c85ba90657b0fe249fc8ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current chanspec on the WLAN radio.  <a href="#gab76c5c1b2c85ba90657b0fe249fc8ebd">More...</a><br /></td></tr>
<tr class="separator:gab76c5c1b2c85ba90657b0fe249fc8ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5c47285f84de334d0991e092c903153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifijoin.html#gaf5c47285f84de334d0991e092c903153">whd_wifi_leave</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:gaf5c47285f84de334d0991e092c903153"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disassociates from a Wi-Fi network.  <a href="#gaf5c47285f84de334d0991e092c903153">More...</a><br /></td></tr>
<tr class="separator:gaf5c47285f84de334d0991e092c903153"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga9f8c6096922212981dd2101a17aec471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f8c6096922212981dd2101a17aec471">&#9670;&nbsp;</a></span>whd_scan_result_callback_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* whd_scan_result_callback_t) (<a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> **result_ptr, void *user_data, <a class="el" href="whd__types_8h.html#a34d5a5749a0bcc00b7249108a8670ada">whd_scan_status_t</a> status)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Scan result callback function pointer type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">result_ptr</td><td>A pointer to the pointer that indicates where to put the next scan result </td></tr>
    <tr><td class="paramname">user_data</td><td>User provided data </td></tr>
    <tr><td class="paramname">status</td><td>Status of scan process </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2604c8dec9eff39e79b3281496da2611"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2604c8dec9eff39e79b3281496da2611">&#9670;&nbsp;</a></span>whd_auth_result_callback_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* whd_auth_result_callback_t) (void *result_ptr, uint32_t len, <a class="el" href="whd__types_8h.html#a853c6ba0cbd32dd7ec37dac9f8ccbfa7">whd_auth_status_t</a> status, uint8_t *flag, void *user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Auth result callback function pointer type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">result_ptr</td><td>A pointer to the pointer that indicates where to put the auth result </td></tr>
    <tr><td class="paramname">len</td><td>the size of result </td></tr>
    <tr><td class="paramname">status</td><td>Status of auth process </td></tr>
    <tr><td class="paramname">flag</td><td>flag of h2e will be indicated in auth request event, otherwise is NULL. </td></tr>
    <tr><td class="paramname">user_data</td><td>user specific data that will be passed directly to the callback function </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad89b3244a31c2ed9122d266b7f99def0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad89b3244a31c2ed9122d266b7f99def0">&#9670;&nbsp;</a></span>whd_wifi_scan_synch()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_scan_synch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#ab30a697b3ebbf2007dc09194b54b1a1b">whd_sync_scan_result_t</a> *&#160;</td>
          <td class="paramname"><em>scan_result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initiates a scan to search for 802.11 networks. </p>
<p>This functions returns the scan results with limited sets of parameter in a buffer provided by the caller. It is also a blocking call. It is an simplified version of the <a class="el" href="group__wifijoin.html#ga253707d44ba49bb46256b38c1c1a204e" title="Initiates a scan to search for 802.11 networks.">whd_wifi_scan()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">scan_result</td><td>Pointer to user requested records buffer. </td></tr>
    <tr><td class="paramname">count</td><td>Pointer to the no of records user is interested in, and also to the no of record received.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>When scanning specific channels, devices with a strong signal strength on nearby channels may be detected</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga253707d44ba49bb46256b38c1c1a204e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga253707d44ba49bb46256b38c1c1a204e">&#9670;&nbsp;</a></span>whd_wifi_scan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_scan </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#af7ac1b0be4ce67f3e82b876c2f27fd3a">whd_scan_type_t</a>&#160;</td>
          <td class="paramname"><em>scan_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#a3070614a06a8989b9eb207e9f1286c5f">whd_bss_type_t</a>&#160;</td>
          <td class="paramname"><em>bss_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *&#160;</td>
          <td class="paramname"><em>optional_ssid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *&#160;</td>
          <td class="paramname"><em>optional_mac</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t *&#160;</td>
          <td class="paramname"><em>optional_channel_list</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structwhd__scan__extended__params__t.html">whd_scan_extended_params_t</a> *&#160;</td>
          <td class="paramname"><em>optional_extended_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wifijoin.html#ga9f8c6096922212981dd2101a17aec471">whd_scan_result_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> *&#160;</td>
          <td class="paramname"><em>result_ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initiates a scan to search for 802.11 networks. </p>
<p>The scan progressively accumulates results over time, and may take between 1 and 10 seconds to complete. The results of the scan will be individually provided to the callback function. Note: The callback function will be executed in the context of the WHD thread and so must not perform any actions that may cause a bus transaction.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">scan_type</td><td>Specifies whether the scan should be Active, Passive or scan Prohibited channels </td></tr>
    <tr><td class="paramname">bss_type</td><td>Specifies whether the scan should search for Infrastructure networks (those using an Access Point), Ad-hoc networks, or both types. </td></tr>
    <tr><td class="paramname">optional_ssid</td><td>If this is non-Null, then the scan will only search for networks using the specified SSID. </td></tr>
    <tr><td class="paramname">optional_mac</td><td>If this is non-Null, then the scan will only search for networks where the BSSID (MAC address of the Access Point) matches the specified MAC address. </td></tr>
    <tr><td class="paramname">optional_channel_list</td><td>If this is non-Null, then the scan will only search for networks on the specified channels - array of channel numbers to search, terminated with a zero </td></tr>
    <tr><td class="paramname">optional_extended_params</td><td>If this is non-Null, then the scan will obey the specifications about dwell times and number of probes. </td></tr>
    <tr><td class="paramname">callback</td><td>The callback function which will receive and process the result data. </td></tr>
    <tr><td class="paramname">result_ptr</td><td>Pointer to a pointer to a result storage structure. </td></tr>
    <tr><td class="paramname">user_data</td><td>user specific data that will be passed directly to the callback function</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>- When scanning specific channels, devices with a strong signal strength on nearby channels may be detected<ul>
<li>Callback must not use blocking functions, nor use WHD functions, since it is called from the context of the WHD thread.</li>
<li>The callback, result_ptr and user_data variables will be referenced after the function returns. Those variables must remain valid until the scan is complete.</li>
</ul>
</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga1b67138e3689fb66ce526810ed188f4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b67138e3689fb66ce526810ed188f4d">&#9670;&nbsp;</a></span>whd_wifi_stop_scan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_stop_scan </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Abort a previously issued scan. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga7a393cc47dd501a2bf00d4a0d305dd6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a393cc47dd501a2bf00d4a0d305dd6e">&#9670;&nbsp;</a></span>whd_wifi_external_auth_request()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_external_auth_request </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wifijoin.html#ga2604c8dec9eff39e79b3281496da2611">whd_auth_result_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>result_ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initiates SAE auth. </p>
<p>The results of the auth will be individually provided to the callback function. Note: The callback function will be executed in the context of the WHD thread and so must not perform any actions that may cause a bus transaction.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">callback</td><td>The callback function which will receive and process the result data. </td></tr>
    <tr><td class="paramname">result_ptr</td><td>Pointer to a pointer to a result storage structure. </td></tr>
    <tr><td class="paramname">user_data</td><td>user specific data that will be passed directly to the callback function</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>- Callback must not use blocking functions, nor use WHD functions, since it is called from the context of the WHD thread.<ul>
<li>The callback, result_ptr and user_data variables will be referenced after the function returns. Those variables must remain valid until the scan is complete.</li>
</ul>
</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="gaf24ce3dea8e8e0d61f5ee82e2429b1b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf24ce3dea8e8e0d61f5ee82e2429b1b4">&#9670;&nbsp;</a></span>whd_wifi_stop_external_auth_request()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_stop_external_auth_request </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Abort authentication request. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="gafde10c6bc61306ec3292a0aede919baf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafde10c6bc61306ec3292a0aede919baf">&#9670;&nbsp;</a></span>whd_wifi_join()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_join </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *&#160;</td>
          <td class="paramname"><em>ssid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a>&#160;</td>
          <td class="paramname"><em>auth_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>security_key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>key_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Joins a Wi-Fi network. </p>
<p>Scans for, associates and authenticates with a Wi-Fi network. On successful return, the system is ready to send data packets.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ssid</td><td>A null terminated string containing the SSID name of the network to join </td></tr>
    <tr><td class="paramname">auth_type</td><td>Authentication type </td></tr>
    <tr><td class="paramname">security_key</td><td>A byte array containing either the cleartext security key for WPA/WPA2/WPA3 secured networks </td></tr>
    <tr><td class="paramname">key_length</td><td>The length of the security_key in bytes.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>In case of WPA3/WPA2 transition mode, the security_key value is WPA3 password.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS when the system is joined and ready to send data packets Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga149e2de0e902c6f7de181c65f93dff3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga149e2de0e902c6f7de181c65f93dff3c">&#9670;&nbsp;</a></span>whd_wifi_join_specific()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_join_specific </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="whd__types_8h.html#a58298b1b5c2f2425d5aed061de48aaa7">whd_scan_result_t</a> *&#160;</td>
          <td class="paramname"><em>ap</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>security_key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>key_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Joins a specific Wi-Fi network. </p>
<p>Associates and authenticates with a specific Wi-Fi access point. On successful return, the system is ready to send data packets.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ap</td><td>A pointer to a whd_scan_result_t structure containing AP details and set ap.channel to 0 for unspecificed channel </td></tr>
    <tr><td class="paramname">security_key</td><td>A byte array containing either the cleartext security key for WPA/WPA2 secured networks </td></tr>
    <tr><td class="paramname">key_length</td><td>The length of the security_key in bytes.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS when the system is joined and ready to send data packets Error code if an error occurred </dd></dl>

</div>
</div>
<a id="gab76c5c1b2c85ba90657b0fe249fc8ebd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab76c5c1b2c85ba90657b0fe249fc8ebd">&#9670;&nbsp;</a></span>whd_wifi_set_chanspec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_set_chanspec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#ac2f5aa33ad4da263645133854e489c76">wl_chanspec_t</a>&#160;</td>
          <td class="paramname"><em>chanspec</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the current chanspec on the WLAN radio. </p>
<dl class="section note"><dt>Note</dt><dd>On most WLAN devices this will set the chanspec for both AP <em>AND</em> STA (since there is only one radio - it cannot be on two chanspec simulaneously)</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">chanspec</td><td>The desired chanspec</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the chanspec was successfully set Error code if the chanspec was not successfully set </dd></dl>

</div>
</div>
<a id="gaf5c47285f84de334d0991e092c903153"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf5c47285f84de334d0991e092c903153">&#9670;&nbsp;</a></span>whd_wifi_leave()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_leave </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disassociates from a Wi-Fi network. </p>
<p>Applicable only for STA role</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS On successful disassociation from the AP Error code If an error occurred </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
    <!-- start footer part -->
    <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
      <ul>
        <li class="footer">Copyright Infineon Technologies.</li>
      </ul>
    </div>
  </body>
</html>
